Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation page sidebar bug #3327

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

jorund1
Copy link
Collaborator

@jorund1 jorund1 commented Mar 14, 2025

A documentation page is included in two TOCs, which seems to cause some anomalies.

Currently, this howto-page appears to be listed under 'Reference material' instead of 'Howtos' in the sidebar.

This PR fixes this anomaly by making sure it is only listed in the 'Howtos' TOC.

Copy link

codecov bot commented Mar 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.79%. Comparing base (0a43109) to head (2f61b54).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3327   +/-   ##
=======================================
  Coverage   60.79%   60.79%           
=======================================
  Files         606      606           
  Lines       43794    43794           
  Branches       48       48           
=======================================
  Hits        26623    26623           
  Misses      17159    17159           
  Partials       12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@johannaengland johannaengland added the nonews No news fragment is necessary for this PR (e.g. refactoring, cleanups, workflow/development changes) label Mar 17, 2025
@lunkwill42
Copy link
Member

@jorund1 if you rebase this on the latest master, the tests should become green again :)

@jorund1 jorund1 force-pushed the fix-documentation-page-sidebar-bug branch from 10a6ed3 to 2f61b54 Compare March 24, 2025 13:10
Copy link
Member

@lunkwill42 lunkwill42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just nitpicking, really :)


../howto/mod_auth_openidc_feide
:ref:`openidc_feide_howto`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really see the point of switching to a named cross-reference when the reference is to a whole document and not a specific section of a document. The old link worked just fine, but the toctree seemed malplaced...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, fixed now

@jorund1 jorund1 requested a review from lunkwill42 March 25, 2025 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nonews No news fragment is necessary for this PR (e.g. refactoring, cleanups, workflow/development changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants